home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 60.zip / BS1 part 60 / Digital Sound Studio d1.adf / DSSReadME < prev    next >
Text File  |  1993-08-10  |  3KB  |  77 lines
  1.  
  2.  --8/10/93------------DSS8+ ARexx Utility Documentation---------------------
  3.  
  4.  This README contains vital new information on the use and capabilities of
  5.  the DSS8+ ARexx utility, DSSRexx.  DSSRexx, which can be found in the
  6.  ARexx drawer, gives you the capability of changing the Line Level Inputs,
  7.  the DCOffset, and the Filter on a hardware level from ARexx.  This is very
  8.  useful when you need to perform sound sampling operations from your
  9.  Multi-Media application.  Please fully read the following before calling
  10.  Technical Support for assistance.
  11.  
  12.  ----------------------------- Getting Started -----------------------------
  13.  
  14.  DSSRexx can be started by double clicking on it's icon or by running it in
  15.  the CLI/Shell.  Once it is started it will open an ARexx message port to
  16.  allow you to control the DSS8+ hardware.
  17.  
  18.  ----------------------------- Usage for ARexx -----------------------------
  19.  
  20.  We have provided a script for each of the functions that is fully
  21.  documented.  You can view these scripts in either a text editor or with a
  22.  text viewer such as "More", which is included with your system software.
  23.  If you have any difficulties using ARexx please refer to your ARexx manual
  24.  from William Hawes or your Commodore Amiga "Using the System Software"
  25.  Manual for assistance.  For general ideas and ARexx programming help you
  26.  should also refer to Abacus books' "Using Arexx on the Amiga" or Merril
  27.  Callaways' "ARexx Cookbook" as these are two excellent sources for help.
  28.  
  29.  ------------------------ Usage for "C" Programmers ------------------------
  30.  
  31.  As DSSRexx passess it's messages in the standard way, using it from a "C"
  32.  program is not difficult.
  33.  
  34.  ARexx communicates with programs by passing messages between standard Exec
  35.  message ports.  The RexxMsg is an extension of the standard Exec Message
  36.  structure, with the additional fields containing Rexx-specific information.
  37.  The structure is defined in <rexx/storage.h>.  Read the ARexx programming
  38.  manual for a more complete description.
  39.  
  40.  DSSRexx parses these RexxMsg's, and returns them (using ReplyMsg()).  The
  41.  name of the DSSRexx ARexx port is "REXX_DSS8".
  42.  
  43.  DSSRexx only pays attention to a few fields of the RexxMsg; rm_Node
  44.  (the Message), rm_Action (for a flag), rm_Result1 (the error code),
  45.  rm_Result2 (the secondary result), and the rm_Args[] (the arguments).
  46.  
  47.  The calling program sets the rm_Args[] to each point to an argument.  For
  48.  example, the equivalent from an ARexx script of:
  49.  
  50.    LEFTGAIN 100
  51.  
  52.  would be:
  53.  
  54.    rm_Args[0] = "LEFTGAIN"
  55.    rm_Args[1] = "100"
  56.    rm_Args[2] = NULL
  57.    .
  58.    .
  59.    .
  60.  
  61.  Note that all the arguments are text strings, including numbers.  If a
  62.  secondary result is desired (e.g. the current Left Gain setting), the
  63.  calling program should set the RXFF_RESULT flag in rm_Action.  (This is
  64.  equivalent to saying OPTIONS RESULTS from a script.)  The calling program
  65.  then PutMsg()s the RexxMsg to the port.
  66.  
  67.  DSSRexx parses the RexxMsg and does the action.  It then sets the
  68.  rm_Result1 field according to how well it went.  0 is success, and
  69.  increasing numbers are worse.  (DSSRexx uses AmigDOS's WARN, FAIL and
  70.  ERROR codes.)  If all is well (rm_Result1 is 0), then the RXFF_RESULT
  71.  flag is checked.  If it is set, then rm_Result2 is set to point to a
  72.  string containing the result.  The RexxMsg is then ReplyMsg()ed.
  73.  
  74.  The calling program checks rm_Result1 (and rm_Result2 if desired),
  75.  and goes on it's way.
  76.  
  77.